<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: req_interface/inc/fpc_sensor_spi.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__sensor__spi_8h_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">fpc_sensor_spi.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="fpc__sensor__spi_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2016 Fingerprint Cards AB &lt;tech@fingerprints.com&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * All rights are reserved.</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Proprietary and confidential.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Unauthorized copying of this file, via any medium is strictly prohibited.</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * Any use is subject to an appropriate license granted by Fingerprint Cards AB.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef FPC_SENSOR_SPI_H</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#define FPC_SENSOR_SPI_H</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;stdint.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="fpc__bep__types_8h.html">fpc_bep_types.h</a>&quot;</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="fpc__sensor__spi_8h.html#aebf41e8e5f8e4af635136283c1863651">   30</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">enum</span> {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    FPC_BEP_SPI_FULL_DUPLEX = 0,</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    FPC_BEP_SPI_HALF_DUPLEX = 1,</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;} <a class="code" href="fpc__sensor__spi_8h.html#aebf41e8e5f8e4af635136283c1863651">fpc_bep_spi_duplex_mode_t</a>;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__sensor__spi_8h.html#a8863f62e7531ba270ae8fcae30ad747a">fpc_sensor_spi_write_read</a>(uint8_t *data, <span class="keywordtype">size_t</span> write_size, <span class="keywordtype">size_t</span> read_size,</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        <span class="keywordtype">bool</span> leave_cs_asserted);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="fpc__sensor__spi_8h.html#a0330b0b1f58c340016e6bd403a9237c5">fpc_sensor_spi_check_irq</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="fpc__sensor__spi_8h.html#af00eb26e4dfd2a354d89fc281c383106">fpc_sensor_spi_read_irq</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fpc__sensor__spi_8h.html#a1d3250f59a2e50929ac1c10310dbdab0">fpc_sensor_spi_reset</a>(<span class="keywordtype">bool</span> state);</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keywordtype">void</span> <a class="code" href="fpc__sensor__spi_8h.html#aa5ebacf0a7cefecf27b08a47ba511760">fpc_sensor_spi_init</a>(uint32_t speed_hz);</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<a class="code" href="fpc__sensor__spi_8h.html#aebf41e8e5f8e4af635136283c1863651">fpc_bep_spi_duplex_mode_t</a> <a class="code" href="fpc__sensor__spi_8h.html#a88ab296f9e86448906262deed2063aa8">fpc_sensor_spi_get_duplex_mode</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="fpc__sensor__spi_8h.html#a6f07e0f8a500105af828f6574f282b92">  103</a></span>&#160;<span class="keyword">typedef</span> bool (*<a class="code" href="fpc__sensor__spi_8h.html#a6f07e0f8a500105af828f6574f282b92">fpc_bep_wfi_check_t</a>)(void);</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<a class="code" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> <a class="code" href="fpc__sensor__spi_8h.html#a38db7e8faa7af2006efee2f91ff0b9f7">fpc_sensor_wfi</a>(uint16_t timeout_ms, <a class="code" href="fpc__sensor__spi_8h.html#a6f07e0f8a500105af828f6574f282b92">fpc_bep_wfi_check_t</a> enter_wfi,</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <span class="keywordtype">bool</span> enter_wfi_mode);</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FPC_SENSOR_SPI_H */</span><span class="preprocessor"></span></div><div class="ttc" id="fpc__bep__types_8h_html"><div class="ttname"><a href="fpc__bep__types_8h.html">fpc_bep_types.h</a></div><div class="ttdoc">Biometric Embedded Platform types. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_af00eb26e4dfd2a354d89fc281c383106"><div class="ttname"><a href="fpc__sensor__spi_8h.html#af00eb26e4dfd2a354d89fc281c383106">fpc_sensor_spi_read_irq</a></div><div class="ttdeci">bool fpc_sensor_spi_read_irq(void)</div><div class="ttdoc">Read sensor IRQ status and then set status to false. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a0330b0b1f58c340016e6bd403a9237c5"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a0330b0b1f58c340016e6bd403a9237c5">fpc_sensor_spi_check_irq</a></div><div class="ttdeci">bool fpc_sensor_spi_check_irq(void)</div><div class="ttdoc">Read sensor IRQ status. </div></div>
<div class="ttc" id="fpc__bep__types_8h_html_adf46f9c3966202d9cf52a82981adaea4"><div class="ttname"><a href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a></div><div class="ttdeci">fpc_bep_result_t</div><div class="ttdoc">Common results returned by BEP functions. </div><div class="ttdef"><b>Definition:</b> fpc_bep_types.h:77</div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a8863f62e7531ba270ae8fcae30ad747a"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a8863f62e7531ba270ae8fcae30ad747a">fpc_sensor_spi_write_read</a></div><div class="ttdeci">fpc_bep_result_t fpc_sensor_spi_write_read(uint8_t *data, size_t write_size, size_t read_size, bool leave_cs_asserted)</div><div class="ttdoc">Writes and reads SPI data. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a38db7e8faa7af2006efee2f91ff0b9f7"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a38db7e8faa7af2006efee2f91ff0b9f7">fpc_sensor_wfi</a></div><div class="ttdeci">fpc_bep_result_t fpc_sensor_wfi(uint16_t timeout_ms, fpc_bep_wfi_check_t enter_wfi, bool enter_wfi_mode)</div><div class="ttdoc">Set system in WFI mode while waiting sensor IRQ. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_aebf41e8e5f8e4af635136283c1863651"><div class="ttname"><a href="fpc__sensor__spi_8h.html#aebf41e8e5f8e4af635136283c1863651">fpc_bep_spi_duplex_mode_t</a></div><div class="ttdeci">fpc_bep_spi_duplex_mode_t</div><div class="ttdoc">FPC sensor SPI modes. </div><div class="ttdef"><b>Definition:</b> fpc_sensor_spi.h:30</div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a88ab296f9e86448906262deed2063aa8"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a88ab296f9e86448906262deed2063aa8">fpc_sensor_spi_get_duplex_mode</a></div><div class="ttdeci">fpc_bep_spi_duplex_mode_t fpc_sensor_spi_get_duplex_mode(void)</div><div class="ttdoc">Check if HAL implements SPI in full duplex or half duplex mode. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_aa5ebacf0a7cefecf27b08a47ba511760"><div class="ttname"><a href="fpc__sensor__spi_8h.html#aa5ebacf0a7cefecf27b08a47ba511760">fpc_sensor_spi_init</a></div><div class="ttdeci">void fpc_sensor_spi_init(uint32_t speed_hz)</div><div class="ttdoc">Initializes SPI master. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a1d3250f59a2e50929ac1c10310dbdab0"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a1d3250f59a2e50929ac1c10310dbdab0">fpc_sensor_spi_reset</a></div><div class="ttdeci">void fpc_sensor_spi_reset(bool state)</div><div class="ttdoc">Set sensor reset state. </div></div>
<div class="ttc" id="fpc__sensor__spi_8h_html_a6f07e0f8a500105af828f6574f282b92"><div class="ttname"><a href="fpc__sensor__spi_8h.html#a6f07e0f8a500105af828f6574f282b92">fpc_bep_wfi_check_t</a></div><div class="ttdeci">bool(* fpc_bep_wfi_check_t)(void)</div><div class="ttdoc">Function that returns a bool deciding if WFI mode should be entered or not. </div><div class="ttdef"><b>Definition:</b> fpc_sensor_spi.h:103</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0d96f899f92a51a54f2a9daafded85a3.html">req_interface</a></li><li class="navelem"><a class="el" href="dir_2904bb0a4c7630347e1aab62443c90ca.html">inc</a></li><li class="navelem"><a class="el" href="fpc__sensor__spi_8h.html">fpc_sensor_spi.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
